package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.OfferInfoAddDTO;
import org.jsola.hr.dto.OfferInfoUpdateDTO;
import org.jsola.hr.query.OfferInfoQuery;
import org.jsola.hr.vo.OfferInfoListVO;
import org.jsola.hr.vo.OfferInfoVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-员工offer信息")
public interface IOfferInfoControllerAPI {

    /**
     * 新增员工offer信息
     * @param offerInfoAddDTO 员工offer信息新增实体
     * @return 员工offer信息展示对象
     */
    @ApiOperation(value = "新增员工offer信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoAddDTO", dataType = "OfferInfoAddDTO", value = "新增员工offer信息", paramType = "body")
    })
    Result<OfferInfoVO> save(OfferInfoAddDTO offerInfoAddDTO);


    /**
     * 修改员工offer信息
     * @param offerInfoUpdateDTO 员工offer信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工offer信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoUpdateDTO", dataType = "OfferInfoUpdateDTO", value = "修改员工offer信息", paramType = "body")
    })
    Result<Integer> update(OfferInfoUpdateDTO offerInfoUpdateDTO);




    /**
     * 删除单个员工offer信息，彻底删除
     * @param offerInfoId 员工offer信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工offer信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoId", dataType = "String", value = "员工offer信息id", paramType = "path")
    })
    Result<Integer> delete(String offerInfoId);


    /**
     * 批量删除员工offer信息，彻底删除
     * @param offerInfoIds 员工offer信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工offer信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoIds", dataType = "String[]", value = "员工offer信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] offerInfoIds);


    /**
     * 根据员工offer信息id查询员工offer信息详情
     * @param offerInfoId 员工offer信息id
     * @return 员工offer信息详情
     */
    @ApiOperation(value="根据员工offer信息id查询员工offer信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoId", dataType = "String", value = "员工offer信息id", paramType = "path")
    })
    Result<OfferInfoVO> findById(String offerInfoId);


    /**
     * 查询员工offer信息
     * @param offerInfoQuery 员工offer信息查询参数
     * @return page
     */
    @ApiOperation(value="查询员工offer信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoQuery", dataType = "OfferInfoQuery", value = "员工offer信息查询参数", paramType = "query")
    })
    Result<List<OfferInfoListVO>> listAll(OfferInfoQuery offerInfoQuery);


     /**
     * 分页查询员工offer信息
     * @param offerInfoQuery 员工offer信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工offer信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoQuery", dataType = "OfferInfoQuery", value = "员工offer信息查询参数", paramType = "query")
    })
    Result<Page<OfferInfoListVO>> page(OfferInfoQuery offerInfoQuery);

    /**
     * 新增员工offer信息并发送给候选人
     * @param offerInfoAddDTO 员工offer信息新增实体
     * @return 员工offer信息展示对象
     */
    @ApiOperation(value = "新增员工offer信息并发送给候选人")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoAddDTO", dataType = "OfferInfoAddDTO", value = "新增员工offer信息并发送给候选人", paramType = "body")
    })
    Result<OfferInfoVO> saveAndSend(OfferInfoAddDTO offerInfoAddDTO);

    /**
     * 获取候选人的offer信息
     * @param offerInfoId 员工offer信息ID
     * @return 员工offer信息展示对象
     */
    @ApiOperation(value = "获取候选人的offer信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "offerInfoId", dataType = "String", value = "候选人的offer信息id", paramType = "query"),
            @ApiImplicitParam(name = "siteId", dataType = "String", value = "所属站点id", paramType = "query")
    })
    Result<OfferInfoVO> getOfferInfoById(String offerInfoId, String siteId);


}

